Red Tractor API Website

Endpoint	Description
https://api.redtractor.org.uk/v1/standards/preview/{schemeguid}/{sectionprefix}
https://api.redtractor.org.uk/v1/standards/preview/{schemeguid}/{sectionguid}

Standards Listing API

Contains methods to access electronic standards for a specific scheme.

Path Parameters

Parameter	Description
schemeguid	the unique reference of the Red Tractor scheme for which to retrieve standards data

List Sections

Retrieves a list of all sections for which electronic standards are available under this scheme

Parameters

Request Parameters

Parameter	Description
SectorPrefixFilter String	Sector Prefix Filter

Response Parameters

Parameter	Description
SchemeName String	Scheme NameOptional
SchemeGUID String	Scheme GUIDOptional
CacheDate Date / Time	Cache DateOptional
Scopes List	ScopesOptional
guid String	Scope GUIDOptional
name String	Scope NameOptional
startdate Date / Time	Start DateOptional
enddate Date / Time	End DateOptional
Sections List	SectionsOptional
scopeguid String	Scope GUIDOptional
sectorprefix String	Sector PrefixOptional
guid String	Section GUIDOptional
name String	Section NameOptional
description String	Section DescriptionOptional
prefix String	Section PrefixOptional
index Number	IndexOptional
modifieddate Date / Time	Modified DateOptional

XML

Example Request

GET https://api.redtractor.org.uk/v1/standards/preview/{schemeguid}.eb?SectorPrefixFilter=String HTTP/1.1
Accept: text/xml

Response Schema

<?xml version="1.0" encoding="utf-8"?>
<xsd:schema elementFormDefault="qualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:element name="Sections">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="SchemeName" minOccurs="0" type="xsd:string" />
        <xsd:element name="SchemeGUID" minOccurs="0" type="xsd:string" />
        <xsd:element name="CacheDate" minOccurs="0" type="xsd:dateTime" />
        <xsd:element name="Scopes" minOccurs="0">
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                <xsd:complexType>
                  <xsd:sequence>
                    <xsd:element name="guid" minOccurs="0" type="xsd:string" />
                    <xsd:element name="name" minOccurs="0" type="xsd:string" />
                    <xsd:element name="startdate" minOccurs="0" type="xsd:dateTime" />
                    <xsd:element name="enddate" minOccurs="0" type="xsd:dateTime" />
                  </xsd:sequence>
                </xsd:complexType>
              </xsd:element>
            </xsd:sequence>
          </xsd:complexType>
        </xsd:element>
        <xsd:element name="Sections" minOccurs="0">
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                <xsd:complexType>
                  <xsd:sequence>
                    <xsd:element name="scopeguid" minOccurs="0" type="xsd:string" />
                    <xsd:element name="sectorprefix" minOccurs="0" type="xsd:string" />
                    <xsd:element name="guid" minOccurs="0" type="xsd:string" />
                    <xsd:element name="name" minOccurs="0" type="xsd:string" />
                    <xsd:element name="description" minOccurs="0" type="xsd:string" />
                    <xsd:element name="prefix" minOccurs="0" type="xsd:string" />
                    <xsd:element name="index" minOccurs="0" type="xsd:double" />
                    <xsd:element name="modifieddate" minOccurs="0" type="xsd:dateTime" />
                  </xsd:sequence>
                </xsd:complexType>
              </xsd:element>
            </xsd:sequence>
          </xsd:complexType>
        </xsd:element>
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>
</xsd:schema>

Example Response

HTTP/1.1 200 OK
Content-Type: text/xml

<?xml version="1.0" encoding="utf-8"?>
<Sections>
  <SchemeName>xsd:string</SchemeName>
  <SchemeGUID>xsd:string</SchemeGUID>
  <CacheDate>xsd:dateTime</CacheDate>
  <Scopes>
    <Item>
      <guid>xsd:string</guid>
      <name>xsd:string</name>
      <startdate>xsd:dateTime</startdate>
      <enddate>xsd:dateTime</enddate>
    </Item>...</Scopes>
  <Sections>
    <Item>
      <scopeguid>xsd:string</scopeguid>
      <sectorprefix>xsd:string</sectorprefix>
      <guid>xsd:string</guid>
      <name>xsd:string</name>
      <description>xsd:string</description>
      <prefix>xsd:string</prefix>
      <index>xsd:double</index>
      <modifieddate>xsd:dateTime</modifieddate>
    </Item>...</Sections>
</Sections>

Download full schema

JSON

Example Request

GET https://api.redtractor.org.uk/v1/standards/preview/{schemeguid}.eb?SectorPrefixFilter=String HTTP/1.1
Accept: application/json

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{"SchemeName":String,
  "SchemeGUID":String,
  "CacheDate":String,
  "Scopes":[{"guid":String,
      "name":String,
      "startdate":String,
      "enddate":String},
    ...],
  "Sections":[{"scopeguid":String,
      "sectorprefix":String,
      "guid":String,
      "name":String,
      "description":String,
      "prefix":String,
      "index":Number,
      "modifieddate":String},
    ...]}